API Overview
floLIVE exposes set of RESTful Public APIs for external customer systems. This document contains the floLIVE Public APIsfor Versions 2 and 3.
Purpose and Scope
The purpose of this document is to provide external systems with descriptive information of the interfaces that floLIVE supports. These interfaces denote the full set of functionalities that the floLIVE Public API exposes.
Technology
The following API technology is used universally in the floLIVE Public APIs:
| Element | Technology |
|---|---|
| Integration Type | Synchronous |
| Interface Type | REST |
| Communication Protocol | HTTPS |
| Communication Format | JSON |
| Invocation Schedule | On demand |
Data Security
All communication is conducted on a secure HTTPS connection. The SSL settings are defined during the integration process.
NOTE: There is no need for Network Level security.
Protocol Layer Errors
The Protocol layer errors are as follows:
| Description | Retry |
|---|---|
| I/O Errors | Yes |
| Timeout | Yes |
| HTTP Codes: | |
| 200 – OK | |
| 202 – Accepted | No |
| 400 – Bad (invalid) Request | No |
| 401 – Unauthorized | Yes |
| 403 – Forbidden | No |
| 404 – Not Found | Yes |
| 500 – Internal Server Error | Yes |
Feature Availability
This Knowledge Base documents the full range of floLIVE platform capabilities. Some of the API functions described may not be available to all customers. Availability of API functions depends on customer agreements, configured permissions, and specific use cases. Certain capabilities may be enabled only for selected customers or roles, or made available as part of a controlled introduction phase.